UserFormBean.java

/*
 * Copyright (c) 2005-2011 Grameen Foundation USA
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * See also http://www.apache.org/licenses/LICENSE-2.0.html for an
 * explanation of the license and how it is applied.
 */

package org.mifos.ui.core.controller;

import java.io.Serializable;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

import org.apache.commons.lang.StringUtils;
import org.hibernate.validator.constraints.NotEmpty;
import org.joda.time.DateTime;
import org.mifos.dto.domain.CustomFieldDto;
import org.mifos.dto.screen.PersonnelNoteDto;
import org.mifos.platform.validation.MifosBeanValidator;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.binding.message.MessageBuilder;
import org.springframework.binding.message.MessageContext;
import org.springframework.binding.validation.ValidationContext;
import org.springframework.format.annotation.NumberFormat;

@SuppressWarnings("PMD")
@edu.umd.cs.findbugs.annotations.SuppressWarnings(value={"RV_RETURN_VALUE_IGNORED_BAD_PRACTICE", "SE_BAD_FIELD", "NP_UNWRITTEN_FIELD", "SE_NO_SERIALVERSIONID"}, justification="required for spring web flow storage at a minimum - should disable at filter level and also for pmd")
public class UserFormBean implements Serializable {

    // office
    @NotNull
    private Long officeId;
    private String officeName;

    // user details
    private Long userId;
    private Integer statusId = Integer.valueOf(1);
    @NotEmpty
    private String firstName;
    private String middleName;
    private String secondLastName;
    @NotEmpty
    private String lastName;
    private String displayName;

    private String governmentId;
    private String email;

    @Min(value=1)
    @Max(value=31)
    @NotNull
    private Number dateOfBirthDay;
    @Min(value=1)
    @Max(value=12)
    @NotNull
    private Number dateOfBirthMonth;
    @NumberFormat(pattern="####")
    @NotNull
    private Number dateOfBirthYear;

    @NotEmpty
    private String selectedGender;
    private Map<String, String> genderOptions = new LinkedHashMap<String, String>();

    private String selectedMaritalStatus;
    private Map<String, String> maritalStatusOptions = new LinkedHashMap<String, String>();

    private String selectedPreferredLanguage;
    private Map<String, String> preferredLanguageOptions = new LinkedHashMap<String, String>();

    @Min(value=1)
    @Max(value=31)
    private Number mfiJoiningDateDay;
    @Min(value=1)
    @Max(value=12)
    private Number mfiJoiningDateMonth;
    @NumberFormat(pattern="####")
    private Number mfiJoiningDateYear;

    // address details
    private AddressBean address = new AddressBean();

    // permissions
    private String selectedUserTitle;
    private Map<String, String> userTitleOptions = new LinkedHashMap<String, String>();

    @NotEmpty
    private String selectedUserHierarchy;
    private Map<String, String> userHierarchyOptions = new LinkedHashMap<String, String>();

    private String[] availableRoles;
    private Map<String, String> availableRolesOptions = new LinkedHashMap<String, String>();

    private String[] selectedRoles;
    private Map<String, String> selectedRolesOptions = new LinkedHashMap<String, String>();

    // login info
    @NotEmpty
    private String username;

    // custom validation
    private String password;
    private String confirmedPassword;

    private List<CustomFieldDto> customFields = new ArrayList<CustomFieldDto>();
    private List<DateFieldBean> customDateFields = new ArrayList<DateFieldBean>();

    // preview fields
    private DateTime dateOfBirth;
    private DateTime passwordExpirationDate;
    private Integer age;
    private DateTime mfiJoiningDate;
    private List<String> selectedRoleNames;
    private String maritalStatusName = "";
    private String genderName = "";
    private String preferredLanguageName = "";
    private String userTitleName = "";
    private String userHierarchyName = "";
    private List<PersonnelNoteDto> recentNotes = new ArrayList<PersonnelNoteDto>();

    @Min(value=1)
    @Max(value=31)
    @NotNull
    private Integer passwordExpirationDateDay;
    @Min(value=1)
    @Max(value=12)
    @NotNull
    private Integer passwordExpirationDateMonth;
    @NumberFormat(pattern="####")
    @NotNull
    private Integer passwordExpirationDateYear;
    
    @Autowired
    private transient MifosBeanValidator validator;

    public void setValidator(MifosBeanValidator validator) {
        this.validator = validator;
    }

    public void validateEditUserDetailsStep(ValidationContext context) {
        validateEnterUserDetailsStep(context);
    }

    @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="REC_CATCH_EXCEPTION", justification="should be the exception thrown by jodatime but not sure what it is right now.")
    public void validateEnterUserDetailsStep(ValidationContext context) {
        MessageContext messages = context.getMessageContext();
        
        validator.validate(this, messages);

        try {
            this.dateOfBirth = new DateTime().withDate(this.dateOfBirthYear.intValue(), this.dateOfBirthMonth.intValue(), this.dateOfBirthDay.intValue());
        } catch (Exception e) {
            messages.addMessage(new MessageBuilder().error().source("dateOfBrith").code("NotValid.UserFormBean.dateOfBrith").defaultText("dateOfBirth is not valid").build());
        }
        
        try {
            this.passwordExpirationDate = new DateTime().withDate(this.passwordExpirationDateYear.intValue(), this.passwordExpirationDateMonth.intValue(), this.passwordExpirationDateDay.intValue());
        } catch (Exception e) {
            messages.addMessage(new MessageBuilder().error().source("passwordExpirationDate").code("NotValid.UserFormBean.passwordExpirationDate").defaultText("Password expiration date is not valid").build());
        }

        try {
            this.mfiJoiningDate = new DateTime().withDate(this.mfiJoiningDateYear.intValue(), this.mfiJoiningDateMonth.intValue(), this.mfiJoiningDateDay.intValue());
        } catch (Exception e) {
            messages.addMessage(new MessageBuilder().error().source("mfiJoiningDate").code("NotValid.UserFormBean.mfiJoiningDate").defaultText("mfiJoiningDate is not valid").build());
        }

        if (this.password.trim().isEmpty() || this.confirmedPassword.trim().isEmpty()) {
            messages.addMessage(new MessageBuilder().error().source("password").code("NotEmpty.UserFormBean.password").defaultText("password is not correct.").build());
        } else if (this.password.trim().length() < 6) {
            messages.addMessage(new MessageBuilder().error().source("password").code("Min.UserFormBean.password").defaultText("password must have six characters at least.").build());
        } else if (!this.password.equals(this.confirmedPassword)) {
            messages.addMessage(new MessageBuilder().error().source("password").code("NotEqual.UserFormBean.password").defaultText("password is not correct.").build());
        }

        this.address.validate(messages, "UserFormBean");

        // validate additional fields
        for (CustomFieldDto additionalField : this.customFields) {

            switch (additionalField.getFieldType().intValue()) {
            case 0:
                break;
            case 1:
                validateNumericField(messages, additionalField);
                break;
            case 2:
                validateIfMandatoryField(messages, additionalField);
                break;
            case 3:
                for (DateFieldBean dateFieldBean : this.customDateFields) {
                    if (dateFieldBean.getId().equals(additionalField.getFieldId())) {
                        validateAndBindDateField(messages, additionalField, dateFieldBean);
                    }
                }
                break;
            default:
                break;
            }
        }

        if (messages.hasErrorMessages()) {
            this.prepateForReEdit();
        }
    }

    private boolean validateIfMandatoryField(MessageContext messages, CustomFieldDto additionalField) {
        boolean validated = true;
        if (additionalField.isMandatory() && StringUtils.isBlank(additionalField.getFieldValue())) {
            messages.addMessage(new MessageBuilder().error().source("customFields").code("NotEmpty.UserFormBean.additionalfield").defaultText("mandatory additional field cannot be blank").build());
            validated = false;
        }
        return validated;
    }

    private void validateAndBindDateField(MessageContext messages, CustomFieldDto additionalField, DateFieldBean additionalDateField) {
        if (additionalDateField.isMandatory()) {
            bindDateField(messages, additionalField, additionalDateField);
        } else {
            if (additionalDateField.getDay() != null || additionalDateField.getMonth() != null || additionalDateField.getYear() != null) {
                bindDateField(messages, additionalField, additionalDateField);
            }
        }
    }

    private void bindDateField(MessageContext messages, CustomFieldDto additionalField, DateFieldBean additionalDateField) {
        try {
            DateTime date = new DateTime().withDate(Integer.valueOf(additionalDateField.getYear()), additionalDateField.getMonth().intValue(), additionalDateField.getDay().intValue());
            SimpleDateFormat format = new SimpleDateFormat("dd/MM/yyyy");
            additionalField.setFieldValue(format.format(date.toDate()));
        } catch (Throwable e) {
            messages.addMessage(new MessageBuilder().error().source("customFields").code("Valid.UserFormBean.additionaldatefield").defaultText("date not valid.").build());
        }
    }

    private void validateNumericField(MessageContext messages, CustomFieldDto additionalField) {
        if (validateIfMandatoryField(messages, additionalField) && StringUtils.isNotBlank(additionalField.getFieldValue())) {
            try {
                Double.valueOf(additionalField.getFieldValue());
            } catch (Exception e) {
                messages.addMessage(new MessageBuilder().error().source("customFields").code("Valid.UserFormBean.additionalnumberfield").defaultText("number not provided.").build());
            }
        }

    }

    public void prepateForReEdit() {

        // handle edge case scenario
        if (this.selectedRoles != null && this.selectedRoles.length == 1 && this.availableRoles != null && this.availableRoles.length == 1 && this.selectedRoles[0].equals(this.availableRoles[0])) {
            String role = this.availableRoles[0];
            if (this.availableRolesOptions.containsKey(role)) {
               this.availableRoles = null;
               this.selectedRoles = null;
               String value = this.availableRolesOptions.remove(role);
               this.selectedRolesOptions.put(role, value);
            } else if (this.selectedRolesOptions.containsKey(role)) {
               this.availableRoles = null;
               this.selectedRoles = null;
               String value = this.selectedRolesOptions.remove(role);
               this.availableRolesOptions.put(role, value);
            }
        }

        String[] chosenRoles = this.selectedRoles;
        if (chosenRoles != null) {
            for (String role : chosenRoles) {
                if (this.availableRolesOptions.containsKey(role)) {
                    String value = this.availableRolesOptions.remove(role);
                    this.selectedRolesOptions.put(role, value);
                }

                if (this.availableRoles != null && this.availableRoles.length == 1 && this.availableRoles[0].equals(role)) {
                    this.availableRoles = null;
                }
            }
        }

        String[] notChosenRoles = this.availableRoles;
        if (notChosenRoles != null) {
            for (String role : notChosenRoles) {
                if (this.selectedRolesOptions.containsKey(role)) {
                    String value = this.selectedRolesOptions.remove(role);
                    this.availableRolesOptions.put(role, value);
                }

                if (this.selectedRoles != null && this.selectedRoles.length == 1 && this.selectedRoles[0].equals(role)) {
                    this.selectedRoles = null;
                }
            }
        }
    }

    public void prepareForPreview() {
        this.dateOfBirth = new DateTime().withDate(this.dateOfBirthYear.intValue(), this.dateOfBirthMonth.intValue(), this.dateOfBirthDay.intValue());
        this.passwordExpirationDate = new DateTime().withDate(this.passwordExpirationDateYear.intValue(), this.passwordExpirationDateMonth.intValue(), 
        		this.passwordExpirationDateDay.intValue());
        this.age = new DateTime().yearOfEra().getDifference(this.dateOfBirth);
        this.mfiJoiningDate = new DateTime().withDate(this.mfiJoiningDateYear.intValue(), this.mfiJoiningDateMonth.intValue(), this.mfiJoiningDateDay.intValue());

        if (StringUtils.isNotBlank(this.selectedMaritalStatus)) {
            this.maritalStatusName = this.maritalStatusOptions.get(this.selectedMaritalStatus);
        }

        this.genderName = this.genderOptions.get(this.selectedGender);

        if (StringUtils.isNotBlank(this.selectedPreferredLanguage)) {
            this.preferredLanguageName = this.preferredLanguageOptions.get(this.selectedPreferredLanguage);
        }

        if (StringUtils.isNotBlank(this.selectedUserTitle)) {
            this.userTitleName = this.userTitleOptions.get(this.selectedUserTitle);
        }

        this.userHierarchyName = this.userHierarchyOptions.get(this.selectedUserHierarchy);

        this.selectedRoleNames = new ArrayList<String>();
        if (this.selectedRoles != null) {
            for (String roleName : this.selectedRoles) {
                if (this.selectedRolesOptions.containsKey(roleName)) {
                    this.selectedRoleNames.add(this.selectedRolesOptions.get(roleName));
                } else if (this.availableRolesOptions.containsKey(roleName)) {
                    this.selectedRoleNames.add(this.availableRolesOptions.get(roleName));
                }
            }
        }
    }

    public String getOfficeName() {
        return this.officeName;
    }

    public void setOfficeName(String officeName) {
        this.officeName = officeName;
    }

    public Long getOfficeId() {
        return this.officeId;
    }

    public void setOfficeId(Long officeId) {
        this.officeId = officeId;
    }

    public String getFirstName() {
        return this.firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getMiddleName() {
        return this.middleName;
    }

    public void setMiddleName(String middleName) {
        this.middleName = middleName;
    }

    public String getSecondLastName() {
        return this.secondLastName;
    }

    public void setSecondLastName(String secondLastName) {
        this.secondLastName = secondLastName;
    }

    public String getLastName() {
        return this.lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public String getGovernmentId() {
        return this.governmentId;
    }

    public void setGovernmentId(String governmentId) {
        this.governmentId = governmentId;
    }

    public String getEmail() {
        return this.email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public Number getDateOfBirthDay() {
        return this.dateOfBirthDay;
    }

    public void setDateOfBirthDay(Number dateOfBirthDay) {
        this.dateOfBirthDay = dateOfBirthDay;
    }

    public Number getDateOfBirthMonth() {
        return this.dateOfBirthMonth;
    }

    public void setDateOfBirthMonth(Number dateOfBirthMonth) {
        this.dateOfBirthMonth = dateOfBirthMonth;
    }

    public Number getDateOfBirthYear() {
        return this.dateOfBirthYear;
    }

    public void setDateOfBirthYear(Number dateOfBirthYear) {
        this.dateOfBirthYear = dateOfBirthYear;
    }

    public String getSelectedMaritalStatus() {
        return this.selectedMaritalStatus;
    }

    public void setSelectedMaritalStatus(String selectedMaritalStatus) {
        this.selectedMaritalStatus = selectedMaritalStatus;
    }

    public Map<String, String> getMaritalStatusOptions() {
        return this.maritalStatusOptions;
    }

    public void setMaritalStatusOptions(Map<String, String> maritalStatusOptions) {
        this.maritalStatusOptions = maritalStatusOptions;
    }

    public String getSelectedPreferredLanguage() {
        return this.selectedPreferredLanguage;
    }

    public void setSelectedPreferredLanguage(String selectedPreferredLanguage) {
        this.selectedPreferredLanguage = selectedPreferredLanguage;
    }

    public Map<String, String> getPreferredLanguageOptions() {
        return this.preferredLanguageOptions;
    }

    public void setPreferredLanguageOptions(Map<String, String> preferredLanguageOptions) {
        this.preferredLanguageOptions = preferredLanguageOptions;
    }

    public Number getMfiJoiningDateDay() {
        return this.mfiJoiningDateDay;
    }

    public void setMfiJoiningDateDay(Number mfiJoiningDateDay) {
        this.mfiJoiningDateDay = mfiJoiningDateDay;
    }

    public Number getMfiJoiningDateMonth() {
        return this.mfiJoiningDateMonth;
    }

    public void setPasswordExpirationDateDay(Integer passwordExpirationDateDay) {
		this.passwordExpirationDateDay = passwordExpirationDateDay;
	}

	public void setPasswordExpirationDateMonth(Integer passwordExpirationDateMonth) {
		this.passwordExpirationDateMonth = passwordExpirationDateMonth;
	}

	public void setPasswordExpirationDateYear(Integer passwordExpirationDateYear) {
		this.passwordExpirationDateYear = passwordExpirationDateYear;
	}

	public void setMfiJoiningDateMonth(Number mfiJoiningDateMonth) {
        this.mfiJoiningDateMonth = mfiJoiningDateMonth;
    }

    public Number getMfiJoiningDateYear() {
        return this.mfiJoiningDateYear;
    }

    public void setMfiJoiningDateYear(Number mfiJoiningDateYear) {
        this.mfiJoiningDateYear = mfiJoiningDateYear;
    }

    public String getSelectedUserTitle() {
        return this.selectedUserTitle;
    }

    public void setSelectedUserTitle(String selectedUserTitle) {
        this.selectedUserTitle = selectedUserTitle;
    }

    public Map<String, String> getUserTitleOptions() {
        return this.userTitleOptions;
    }

    public void setUserTitleOptions(Map<String, String> userTitleOptions) {
        this.userTitleOptions = userTitleOptions;
    }

    public String getSelectedUserHierarchy() {
        return this.selectedUserHierarchy;
    }

    public void setSelectedUserHierarchy(String selectedUserHierarchy) {
        this.selectedUserHierarchy = selectedUserHierarchy;
    }

    public Map<String, String> getUserHierarchyOptions() {
        return this.userHierarchyOptions;
    }

    public void setUserHierarchyOptions(Map<String, String> userHierarchyOptions) {
        this.userHierarchyOptions = userHierarchyOptions;
    }

    public String getUsername() {
        return this.username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return this.password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getConfirmedPassword() {
        return this.confirmedPassword;
    }

    public void setConfirmedPassword(String confirmedPassword) {
        this.confirmedPassword = confirmedPassword;
    }

    @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="EI_EXPOSE_REP", justification="..")
    public String[] getAvailableRoles() {
        return this.availableRoles;
    }

    @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="EI_EXPOSE_REP", justification="..")
    public void setAvailableRoles(String[] availableRoles) {
        this.availableRoles = availableRoles;
    }

    public Map<String, String> getAvailableRolesOptions() {
        return this.availableRolesOptions;
    }

    public void setAvailableRolesOptions(Map<String, String> availableRolesOptions) {
        this.availableRolesOptions = availableRolesOptions;
    }

    @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="EI_EXPOSE_REP", justification="..")
    public String[] getSelectedRoles() {
        return this.selectedRoles;
    }

    @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="EI_EXPOSE_REP", justification="..")
    public void setSelectedRoles(String[] selectedRoles) {
        this.selectedRoles = selectedRoles;
    }

    public Map<String, String> getSelectedRolesOptions() {
        return this.selectedRolesOptions;
    }

    public void setSelectedRolesOptions(Map<String, String> selectedRolesOptions) {
        this.selectedRolesOptions = selectedRolesOptions;
    }

    public AddressBean getAddress() {
        return this.address;
    }

    public void setAddress(AddressBean address) {
        this.address = address;
    }

    public String getSelectedGender() {
        return this.selectedGender;
    }

    public void setSelectedGender(String selectedGender) {
        this.selectedGender = selectedGender;
    }

    public Map<String, String> getGenderOptions() {
        return this.genderOptions;
    }

    public void setGenderOptions(Map<String, String> genderOptions) {
        this.genderOptions = genderOptions;
    }

    public String getDateOfBirth() {
        return org.joda.time.format.DateTimeFormat.forPattern("dd/MM/yyyy").withLocale(Locale.getDefault()).print(this.dateOfBirth);
    }

    public DateTime getDateOfBirthAsDateTime() {
        return this.dateOfBirth;
    }
    
    public DateTime getPasswordExpirationDateAsDateTime() {
        return this.passwordExpirationDate;
    }

    public Integer getAge() {
        return this.age;
    }

    public String getMfiJoiningDate() {
        return org.joda.time.format.DateTimeFormat.forPattern("dd/MM/yyyy").withLocale(Locale.getDefault()).print(this.mfiJoiningDate);
    }

    public String getPasswordExpirationDate() {
        return org.joda.time.format.DateTimeFormat.forPattern("dd/MM/yyyy").withLocale(Locale.getDefault()).print(this.passwordExpirationDate);
    }
    
    public DateTime getMfiJoiningDateAsDateTime() {
        return this.mfiJoiningDate;
    }

    public List<String> getSelectedRoleNames() {
        return this.selectedRoleNames;
    }

    public String getMaritalStatusName() {
        return this.maritalStatusName;
    }

    public String getGenderName() {
        return this.genderName;
    }

    public String getPreferredLanguageName() {
        return this.preferredLanguageName;
    }

    public String getUserTitleName() {
        return this.userTitleName;
    }

    public String getUserHierarchyName() {
        return this.userHierarchyName;
    }

    public List<CustomFieldDto> getCustomFields() {
        return this.customFields;
    }

    public void setCustomFields(List<CustomFieldDto> customFields) {
        this.customFields = customFields;
    }

    public List<DateFieldBean> getCustomDateFields() {
        return this.customDateFields;
    }

    public void setCustomDateFields(List<DateFieldBean> customDateFields) {
        this.customDateFields = customDateFields;
    }

    public Long getUserId() {
        return this.userId;
    }

    public void setUserId(Long userId) {
        this.userId = userId;
    }

    public Integer getStatusId() {
        return this.statusId;
    }

    public void setStatusId(Integer statusId) {
        this.statusId = statusId;
    }

    public String getDisplayName() {
        return this.displayName;
    }

    public void setDisplayName(String displayName) {
        this.displayName = displayName;
    }

    public List<PersonnelNoteDto> getRecentNotes() {
        return this.recentNotes;
    }

    public boolean isRecentNotesEmpty() {
        return this.recentNotes.isEmpty();
    }

    public void setRecentNotes(List<PersonnelNoteDto> recentNotes) {
        this.recentNotes = recentNotes;
    }
}